/*
 * 版权所有 (C) 2015 知启蒙(ZHIQIM) 保留所有权利。[遇见知启蒙，邂逅框架梦，本文采用木兰宽松许可证第2版]
 * 
 * https://zhiqim.org/project/zhiqim_kit/zhiqim_git.htm
 *
 * ZhiqimGit is licensed under Mulan PSL v2.
 * You can use this software according to the terms and conditions of the Mulan PSL v2.
 * You may obtain a copy of Mulan PSL v2 at:
 *          http://license.coscl.org.cn/MulanPSL2
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
 * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PSL v2 for more details.
 */
package org.zhiqim.git.refer;

import org.zhiqim.git.objer.objectid.ObjectId;
import org.zhiqim.git.refer.ref.ObjectIdRef;
import org.zhiqim.git.refer.ref.SymbolicRef;


/**
 * 引用接口定义，引用有两种：
 * @see ObjectIdRef     1)真实对象引用，指向一个ObjectId
 * @see SymbolicRef     2)快捷方式引用，指向目标引用（通过getLeaf找到真实对象引用）
 * 
 * @version v1.0.0 @author zouzhigang 2017-3-20 新建与整理
 */
public interface Ref
{
    /** 引用名称 */
    public String getName();
    
    
    /**********************************************************************************/
    //快捷方式
    /**********************************************************************************/

    
    /** 判断是否快捷方式 */
    public boolean isSymbolic();

    /** 获取目标引用，如果非快捷方式表示自己，快捷方式引用得到目标对象 */
    public Ref getTarget();
    
    /** 获取终极目标引用，如果是快捷方式则递归调用getTarget()直到isSymbolic=false的引用 */
    public ObjectIdRef getUltimateTarget();
    
    
    /**********************************************************************************/
    //标签判断
    /**********************************************************************************/

    
    /** 判断是否有注释标签 */
    public boolean isPeeled();
    
    /** 
     * 获取指定注释标签的对象编号
     * 
     * 1、如果有注释标签，返回null
     * 2、是注释标签，如ref^{commit}表示返回RevCommit，类似还有(tree,blob等) 
     s*/
    public ObjectId getPeeledObjectId();

    
    /**********************************************************************************/
    //对象&文件
    /**********************************************************************************/
    
    
    /** 获取对象编号 */
    public ObjectId getObjectId();
    
    /** 是否存储 */
    public boolean isStored();
    
}
